Esx Settings Clusters Vms Solutions SolutionInfo
The Esx Settings Clusters Vms Solutions SolutionInfo schema contains properties that describe the desired specification of a System VM solution.
This schema was added in vSphere API 9.0.0.0.
{
"deployment_type": "string",
"display_name": "string",
"display_version": "string",
"vm_name_template": {
"prefix": "string",
"suffix": "string"
},
"host_solution_info": {
"prefer_host_configuration": false,
"vm_networks": [
"string"
],
"vm_datastores": [
"string"
]
},
"cluster_solution_info": {
"vm_count": 0,
"vm_placement_policies": [
"string"
],
"vm_networks": {
"vm_networks": "string"
},
"vm_datastores": [
"string"
],
"devices": {}
},
"hook_configurations": {
"hook_configurations": {
"timeout": 0
}
},
"ovf_resource": {
"location_type": "string",
"url": "string",
"ssl_certificate_validation": "string",
"certificate": "string"
},
"ovf_descriptor_properties": {
"ovf_descriptor_properties": "string"
},
"vm_clone_config": "string",
"vm_storage_policy": "string",
"vm_storage_profiles": [
"string"
],
"vm_disk_type": "string",
"vm_resource_pool": "string",
"vm_folder": "string",
"vm_resource_spec": {
"ovf_deployment_option": "string"
}
}
Deployment type of the solution.
For more information see: Esx Settings Clusters Vms DeploymentType.
This property was added in vSphere API 9.0.0.0.
Display name of the solution.
This property was added in vSphere API 9.0.0.0.
Display version of the solution.
This property was added in vSphere API 9.0.0.0.
VM name template.
This property was added in vSphere API 9.0.0.0.
Information about a configuration that is only applicable to solutions with deployment type Esx Settings Clusters Vms DeploymentType.EVERY_HOST_PINNED
This property was added in vSphere API 9.0.0.0.
This property is optional and it is only relevant when the value of deployment_type is Esx Settings Clusters Vms DeploymentType.EVERY_HOST_PINNED.
Information about a configuration that is only applicable to solutions with deployment type Esx Settings Clusters Vms DeploymentType.CLUSTER_VM_SET
This property was added in vSphere API 9.0.0.0.
This property is optional and it is only relevant when the value of deployment_type is Esx Settings Clusters Vms DeploymentType.CLUSTER_VM_SET.
VM lifecycle hooks configurations. See Esx Settings Clusters Vms LifecycleHooks. The map keys represent Esx Settings Clusters Vms LifecycleStates while the map values represent their configurations.
This property was added in vSphere API 9.0.0.0.
Information about the OVF resource that is used for the VM deployments.
This property was added in vSphere API 9.0.0.0.
OVF properties that are assigned to the VMs' OVF properties when powered on. The keys of the map must not include any white-space characters. The map keys represent the names of properties while the map values represent the values of those properties.
This property was added in vSphere API 9.0.0.0.
VM cloning configuration.
For more information see: Esx Settings Clusters Vms VmCloneConfig.
This property was added in vSphere API 9.0.0.0.
Storage policies that are configured on the VMs.
For more information see: Esx Settings Clusters Vms StoragePolicy.
This property was added in vSphere API 9.0.0.0.
Storage policy profiles that are configured on the VMs. The profiles are passed to vim.vm.ConfigSpec#vmProfile without any interpretation.
This property was added in vSphere API 9.0.0.0.
This property is optional and it is only relevant when the value of vm_storage_policy is Esx Settings Clusters Vms StoragePolicy.PROFILE.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.spbm.StorageProfile
. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.spbm.StorageProfile
.
Disk provisioning type of the VMs.
For more information see: Esx Settings Clusters Vms DiskType.
This property was added in vSphere API 9.0.0.0.
Identifier of the resource pool where the VMs are deployed.
This property was added in vSphere API 9.0.0.0.
if missing or null
the VMs for each compute resource will be deployed under top level nested resource pool created for the solutions. If unable to create a nested resource pool, the root resource pool of the compute resource will be used.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: ResourcePool
. When operations return a value of this schema as a response, the property will be an identifier for the resource type: ResourcePool
.
Identifier of the folder inventory object where VMs are deployed.
This property was added in vSphere API 9.0.0.0.
if missing or null
the VMs are deployed inside the top level folder created in each datacenter for solutions.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: Folder
. When operations return a value of this schema as a response, the property will be an identifier for the resource type: Folder
.
VMs resource configuration.
This property was added in vSphere API 9.0.0.0.
If missing or null
the default resource configuration specified in the OVF descriptor is used.